home *** CD-ROM | disk | FTP | other *** search
/ Die Speccy' 97 / Die Speccy' 97.iso / amiga_system / the_aminet / comm / bbs / pmbs1251_demo.lha / prometheus / developer / pmbsonline.dok < prev    next >
Text File  |  1995-09-19  |  12KB  |  520 lines
  1. TABLE OF CONTENTS
  2.  
  3. pmbsonline.library/pt_OpenPrometheus
  4. pmbsonline.library/pt_ClosePrometheus
  5. pmbsonline.library/pt_Send
  6. pmbsonline.library/pt_Read
  7. pmbsonline.library/pt_BlueRead
  8. pmbsonline.library/pt_Quit
  9. pmbsonline.library/pt_AnsiStatus
  10. pmbsonline.library/pt_AskUser
  11. pmbsonline.library/pt_Logtyp
  12. pmbsonline.library/pt_AskBoxname
  13. pmbsonline.library/pt_ReceiveFile
  14. pmbsonline.library/pt_Sendfile
  15. pmbsonline.library/pt_CheckCarrier
  16. pmbsonline.library/pt_Typefile
  17. pmbsonline.library/pt_GetChar
  18. pmbsonline.library/pt_Command
  19. pmbsonline.library/pt_Arexx
  20.  
  21. pmbsonline.library/pt_OpenPrometheus     pmbsonline.library/pt_OpenPrometheus
  22.  
  23.    NAME
  24.        pt_OpenPrometheus - ╓ffnet den Prometheusport
  25.  
  26.    SYNOPSIS
  27.        PMBSPort = pt_OpenPrometheus(Portnummer)
  28.                                      d0
  29.  
  30.        LONG  pt_OpenPrometheus(LONG);
  31.  
  32.    FUNCTION
  33.        Diese Routine ÷ffnet den Port zu Prometheus.
  34.        Dies muss immer gemacht werden, wenn Portbefehle genutzt werden.
  35.  
  36.    INPUTS
  37.        Portnummer -- Eine Nummer von 0-9 (0 = Mainport)
  38.  
  39.    RESULTS
  40.        PMBSPort -- Ein Pointer auf den Prometheusport
  41.  
  42.    EXCEPTIONS
  43.  
  44.    SEE ALSO
  45.        pt_ClosePrometheus();
  46.  
  47.    BUGS
  48.        Diese Funktion gibt immer eine Adresse zurueckt, auch bei einem FAIL
  49.  
  50. pmbsonline.library/pt_ClosePrometheus   pmbsonline.library/pt_ClosePrometheus
  51.  
  52.    NAME
  53.        pt_ClosePrometheus - Schliesst die Prometheusschnittstelle
  54.  
  55.    SYNOPSIS
  56.        pt_ClosePrometheus(PMBSPort)
  57.                             d0
  58.  
  59.        void pt_ClosePrometheus(LONG);
  60.  
  61.    FUNCTION
  62.        Diese Routine schliesst den mit pt_OpenPrometheus() ge÷ffneten
  63.        PrometheusPort. Dies muss immer am ende gemacht werden.
  64.  
  65.    INPUTS
  66.        PMBSPort -- Ein Pointer auf den Prometheusport
  67.  
  68.    RESULTS
  69.  
  70.    EXCEPTIONS
  71.  
  72.    SEE ALSO
  73.        pt_OpenPrometheus();
  74.  
  75.    BUGS
  76.  
  77.  
  78. pmbsonline.library/pt_Send                         pmbsonline.library/pt_Send
  79.  
  80.    NAME
  81.        pt_Send - Sendet einen String ueber das Modem und Bildschirm
  82.  
  83.    SYNOPSIS
  84.        pt_Send(PMBSPort, String)
  85.                  d0        a0
  86.  
  87.        void pt_Send(LONG, char *);
  88.  
  89.    FUNCTION
  90.        Diese  Routine senden den Text mit Umlautwandlung auf den Bildschirm
  91.        und ueber das Modem.
  92.  
  93.    INPUTS
  94.        PMBSPort -- Ein Pointer auf den Prometheusport
  95.        String   -- Pointer auf einen mit 0 abgeschlossenen String.
  96.  
  97.    RESULTS
  98.  
  99.    EXCEPTIONS
  100.  
  101.    SEE ALSO
  102.  
  103.    BUGS
  104.  
  105. pmbsonline.library/pt_Read                         pmbsonline.library/pt_Read
  106.  
  107.    NAME
  108.        pt_Read - Liest beliebig viele Zeichen von der Tastatur ein.
  109.  
  110.    SYNOPSIS
  111.        pt_Read(PMBSPort, Zeichen, Buffer)
  112.                  d0        a1       a0
  113.  
  114.        void pt_Read(LONG, LONG, char *);
  115.  
  116.    FUNCTION
  117.        Mit dieser Funktion kann man beliebig viele Zeichen eingeben lassen.
  118.        Das Ergebnis im Buffer ist IMMER mit einem 0-Byte abgeschlossen.
  119.  
  120.    INPUTS
  121.        PMBSPort -- Ein Pointer auf den Prometheusport.
  122.        Zeichen  -- Anzahl der einzugebenen Zeichen.
  123.        Buffer   -- Pointer  auf  einen  Bereich, in  dem  der  Text  mit 0
  124.                    abgeschlossen geschrieben wird
  125.  
  126.    RESULTS
  127.        Siehe Buffer
  128.  
  129.    EXCEPTIONS
  130.  
  131.    SEE ALSO
  132.         pt_BlueRead(), pt_GetChar();
  133.  
  134.    BUGS
  135.  
  136. pmbsonline.library/pt_BlueRead                 pmbsonline.library/pt_BlueRead
  137.  
  138.    NAME
  139.        pt_BlueRead - Liest beliebig viele Zeichen von der Tastatur ein.
  140.  
  141.    SYNOPSIS
  142.        pt_BLueRead(PMBSPort, Zeichen, Buffer)
  143.                      d0        a1       a0
  144.  
  145.        void pt_BlueRead(LONG, LONG, char *);
  146.  
  147.    FUNCTION
  148.        Mit dieser Funktion kann man beliebig viele Zeichen eingeben lassen.
  149.        Das Ergebnis im Buffer ist IMMER mit einem 0-Byte abgeschlossen.
  150.        Der Bereich, in dem der Text eingegeben wird ist Blau unterlegt.
  151.  
  152.    INPUTS
  153.        PMBSPort -- Ein Pointer auf den Prometheusport.
  154.        Zeichen  -- Anzahl der einzugebenen Zeichen.
  155.        Buffer   -- Pointer  auf  einen  Bereich, in  dem  der  Text  mit 0
  156.                    abgeschlossen geschrieben wird
  157.  
  158.    RESULTS
  159.        Siehe Buffer
  160.  
  161.    EXCEPTIONS
  162.  
  163.    SEE ALSO
  164.         pt_Read(), pt_GetChar();
  165.  
  166.    BUGS
  167.  
  168. pmbsonline.library/pt_Quit                         pmbsonline.library/pt_Quit
  169.  
  170.    NAME
  171.        pt_Quit - Signalisiert PMBS schliessung des Programmes.
  172.  
  173.    SYNOPSIS
  174.        pt_Quit(PMBSPort)
  175.                   d0
  176.  
  177.        void pt_Quit(LONG);
  178.  
  179.    FUNCTION
  180.        Diese  Funktion  signalisiert  Prometheus, dass das externe Programm
  181.        beendet ist. Sie muss vor pt_ClosePrometheus() aufgerufen werden.
  182.  
  183.    INPUTS
  184.        PMBSPort -- Ein Pointer auf den Prometheusport.
  185.  
  186.    RESULTS
  187.  
  188.    EXCEPTIONS
  189.  
  190.    SEE ALSO
  191.         pt_ClosePrometheus();
  192.  
  193.    BUGS
  194.  
  195. pmbsonline.library/pt_AnsiStatus             pmbsonline.library/pt_AnsiStatus
  196.  
  197.    NAME
  198.        pt_AnsiStatus - Prueft ob der User Ansi anhat
  199.  
  200.    SYNOPSIS
  201.        Emulation = pt_AnsiStatus(PMBSPort)
  202.                                    d0
  203.  
  204.        LONG pt_AnsiStatus(LONG);
  205.  
  206.    FUNCTION
  207.        Hiermit kann man pruefen, ob der eingeloggte User die Ansi-Emulation
  208.        angeschaltet hat.
  209.  
  210.    INPUTS
  211.        PMBSPort -- Ein Pointer auf den Prometheusport.
  212.  
  213.    RESULTS
  214.        Emulation -- 0 == Ansi aus, 1 == Ansi an.
  215.  
  216.    EXCEPTIONS
  217.  
  218.    SEE ALSO
  219.  
  220.    BUGS
  221.  
  222. pmbsonline.library/pt_AskUser                  pmbsonline.library/pt_AskUser
  223.  
  224.    NAME
  225.        pt_AskUser -  Liefert den Namen eines eingeloggten Users.
  226.  
  227.    SYNOPSIS
  228.        pt_AskUser(PMBSPort, Buffer)
  229.                      d0       a0
  230.  
  231.        void pt_AskUser(LONG, char *);
  232.  
  233.    FUNCTION
  234.        Diese Funktion liefert den Usernamen desjenigen, der das Programm
  235.        aufgerufen hat.
  236.  
  237.    INPUTS
  238.        PMBSPort -- Ein Pointer auf den Prometheusport.
  239.        Buffer   -- Pointer  auf  einen  Bereich, in  dem  der  Text  mit 0
  240.                    abgeschlossen geschrieben wird
  241.  
  242.    RESULTS
  243.        Siehe Buffer
  244.  
  245.    EXCEPTIONS
  246.  
  247.    SEE ALSO
  248.  
  249.    BUGS
  250.  
  251. pmbsonline.library/pt_AskLog                   pmbsonline.library/pt_AskLog
  252.  
  253.    NAME
  254.        pt_AskLog - Fragt nach Consolen oder Modemlogin.
  255.  
  256.    SYNOPSIS
  257.        Logtyp pt_AskLog(PMBSPort)
  258.                           d0
  259.  
  260.        short pt_AskLog(LONG);
  261.  
  262.    FUNCTION
  263.        Mit dieser Funktion kann man erfragen ob der User sich von der
  264.        Console eingeloggt hat, oder mit dem Modem.
  265.  
  266.    INPUTS
  267.        PMBSPort -- Ein Pointer auf den Prometheusport.
  268.  
  269.    RESULTS
  270.        Liefert 0 wenn Consolenlogin
  271.        Liefert 1 wenn Modemlogin
  272.  
  273.    EXCEPTIONS
  274.  
  275.    SEE ALSO
  276.  
  277.    BUGS
  278.  
  279. pmbsonline.library/pt_AskBoxname             pmbsonline.library/pt_AskBoxname
  280.  
  281.    NAME
  282.        pt_AskBoxname - Fragt nach dem Namen der Mailbox.
  283.  
  284.    SYNOPSIS
  285.        pt_AskLog(PMBSPort, Buffer)
  286.                             d0
  287.  
  288.        void pt_AskLog(LONG, char *);
  289.  
  290.    FUNCTION
  291.        Diese Funktion liefert in Buffer den Namen der Mailbox.
  292.        Buffer ist mit einem 0-Byte abgeschlossen.
  293.  
  294.    INPUTS
  295.        PMBSPort -- Ein Pointer auf den Prometheusport.
  296.  
  297.    RESULTS
  298.        Buffer -- Name der Mailbox mit einem 0-Byte abgeschlossen.
  299.  
  300.    EXCEPTIONS
  301.  
  302.    SEE ALSO
  303.  
  304.    BUGS
  305.  
  306. pmbsonline.library/pt_ReceiveFile           pmbsonline.library/pt_ReceiveFile
  307.  
  308.    NAME
  309.        pt_ReceiveFile - Empfaengt ein File ueber das Modem.
  310.  
  311.    SYNOPSIS
  312.        pt_ReceiveFile(PMBSPort)
  313.                         d0
  314.  
  315.        void pt_ReceiveFile(LONG);
  316.  
  317.    FUNCTION
  318.        Diese Funktion empfaengt ein oder mehrere Files ueber das
  319.        Modem in das aktuelle Verzeichniss.
  320.        Die/den Filenamen muss der Programmierer selber herausbekommen.
  321.        Es empfiehlt sich vorher mit dem Prometheus-Arexxbefehl SETCD
  322.        in ein leeres Verzeichniss zu wechseln.
  323.  
  324.    INPUTS
  325.        PMBSPort -- Ein Pointer auf den Prometheusport.
  326.  
  327.    RESULTS
  328.  
  329.    EXCEPTIONS
  330.  
  331.    SEE ALSO
  332.        pt_Sendfile()
  333.  
  334.    BUGS
  335.  
  336. pmbsonline.library/pt_Sendfile              pmbsonline.library/pt_Sendfile
  337.  
  338.    NAME
  339.        pt_Sendfile - Sendet ein File ueber das Modem.
  340.  
  341.    SYNOPSIS
  342.        pt_Sendfile(PMBSPort, Filename)
  343.                       d0         a0
  344.  
  345.        void pt_Sendfile(LONG, char *);
  346.  
  347.    FUNCTION
  348.        Diese Funktion sendet ein File an den User.
  349.  
  350.    INPUTS
  351.        PMBSPort  --  Ein Pointer auf den Prometheusport.
  352.        Filename  --  Ein Pointer auf einen mit einem 0-Byte abgeschlossenen
  353.                      Filenamen.
  354.    RESULTS
  355.  
  356.    EXCEPTIONS
  357.  
  358.    SEE ALSO
  359.        pt_ReceiveFile()
  360.  
  361.    BUGS
  362.  
  363. pmbsonline.library/pt_CheckCarrier         pmbsonline.library/pt_CheckCarrier
  364.  
  365.    NAME
  366.        pt_CheckCarrier - Prueft ob ein Carrier besteht.
  367.  
  368.    SYNOPSIS
  369.        Carrier pt_CheckCarrier(PMBSPort)
  370.                                d0
  371.  
  372.        short pt_CheckCarrier(LONG);
  373.  
  374.    FUNCTION
  375.        Mit  dieser  Funktion  kann  man  ueberpruefen  ob  noch ein Carrier
  376.        besteht.
  377.  
  378.    INPUTS
  379.        PMBSPort  --  Ein Pointer auf den Prometheusport.
  380.  
  381.    RESULTS
  382.        Carrier -- entaehlt eine 0, wenn kein Carrier besteht.
  383.                   entaehlt eine 1, wenn ein Carrier besteht.
  384.  
  385.    EXCEPTIONS
  386.        In Carrier steht immer eine 0, wenn ein Consolenlogin besteht.
  387.  
  388.  
  389.    SEE ALSO
  390.        pt_AskLog()
  391.  
  392.    BUGS
  393.  
  394. pmbsonline.library/pt_Typefile                 pmbsonline.library/pt_Typefile
  395.  
  396.    NAME
  397.        pt_Typefile - Sendet ein TextFile ueber das Modem.
  398.  
  399.    SYNOPSIS
  400.        pt_Typefile(PMBSPort, Filename)
  401.                      d0          a1
  402.  
  403.        void pt_Typefile(LONG, char *);
  404.  
  405.    FUNCTION
  406.        TypeFile  gibt  den  Inhalt  eines TextFiles ueber die Serielle aus.
  407.        Beachtet wird hierbei unter anderem auch das Paging.
  408.  
  409.    INPUTS
  410.        PMBSPort  --  Ein Pointer auf den Prometheusport.
  411.        Filename  --  Pointer  auf  einen  mit  einem 0-Byte abgeschlossenen
  412.                      Filenamen.
  413.  
  414.    RESULTS
  415.  
  416.    EXCEPTIONS
  417.  
  418.    SEE ALSO
  419.  
  420.    BUGS
  421.  
  422. pmbsonline.library/pt_GetChar                 pmbsonline.library/pt_GetChar
  423.  
  424.    NAME
  425.        pt_GetChar - Liefert sofort eine gedrueckte Taste zurueck.
  426.  
  427.    SYNOPSIS
  428.        pt_GetChar(PMBSPort, Buffer)
  429.                      d0      a0
  430.  
  431.        void pt_GetChar(LONG, char *);
  432.  
  433.    FUNCTION
  434.        Diese  Funktion  springt  immer  SOFORT  zurⁿck!  Wenn der User also
  435.        nichts gedrⁿckt hat, wird auch nur ein 0 Byte zurⁿck gegeben!  Diese
  436.        Funktion  ist also nur in einer Schleife sinnvoll!  Sie liefert wenn
  437.        ⁿberhaupt  in  den  Buffer  einen  Buchstaben + 0 Byte zurⁿck.  Wenn
  438.        nichts gedrⁿckt wurde halt nur ein 0 Byte
  439.  
  440.    INPUTS
  441.        PMBSPort  --  Ein Pointer auf den Prometheusport.
  442.  
  443.    RESULTS
  444.        Buffer   --   Pointer  auf  einen  Buffer,  in  dem  Prometheus  den
  445.                      eingegebenen  Buchstaben  schreibt.  Buffer wird IMMER
  446.                      mit einem 0-Byte abgeschlossen.
  447.    EXCEPTIONS
  448.  
  449.    SEE ALSO
  450.        pt_Read(), pt_BlueRead()
  451.  
  452.    BUGS
  453.  
  454.  
  455. pmbsonline.library/pt_Command                pmbsonline.library/pt_Command
  456.  
  457.    NAME
  458.        pt_Command - Fuehrt einen Prometheus Befehl aus.
  459.  
  460.    SYNOPSIS
  461.        pt_Command(PMBSPort, String)
  462.                      d0      a0
  463.  
  464.        void pt_Command(LONG, char *);
  465.  
  466.    FUNCTION
  467.        Mit  dieser Funktion ist es moeglich einen Prometheus eigenen Befehl
  468.        auszufuehren (I *, B *).
  469.  
  470.    INPUTS
  471.        PMBSPort  --  Ein Pointer auf den Prometheusport.
  472.        String    --  Pointer  auf einen mit 0 abgeschlossenen String Dieser
  473.                      String  muss  ein  Prometheus  Befehl  wie B * oder so
  474.                      etwas sein!
  475.  
  476.    RESULTS
  477.  
  478.    EXCEPTIONS
  479.  
  480.    SEE ALSO
  481.        pt_Arexx():
  482.  
  483.    BUGS
  484.  
  485. pmbsonline.library/pt_Arexx                    pmbsonline.library/pt_Arexx
  486.  
  487.    NAME
  488.        pt_Arexx - Fuehrt einen Promehteus-ArexxBefehl aus.
  489.  
  490.    SYNOPSIS
  491.        pt_Arexx(PMBSPort, String, Buffer)
  492.                      d0      a0    a1
  493.  
  494.        void pt_Arexx(LONG, char *,  char *);
  495.  
  496.    FUNCTION
  497.        Mit  dieser  Funktion  ist  es  moeglich  die  kompletten Prometheus
  498.        eigenen Arexx-Befehle zu nutzen.
  499.        Es gibt sehr viele PrometheusArexxbefehle... daher ist diese Library
  500.        auch sehr beschrΣnkt. Lesen Sie die Arexx.dok.
  501.  
  502.  
  503.    INPUTS
  504.        PMBSPort  --  Ein Pointer auf den Prometheusport.
  505.        String    --  Pointer auf einen  mit  einem  0-Byte  abgeschlossenen
  506.                      Bereich, der als  ArexxBefehl  an  Prometheus gesendet
  507.                      wird.
  508.  
  509.    RESULTS
  510.         Buffer -- Pointer auf einen Bereich, nach dem Prometheus den Result
  511.                   des ArexxBefehles schreibt.
  512.  
  513.    EXCEPTIONS
  514.  
  515.    SEE ALSO
  516.        pt_Command():
  517.  
  518.    BUGS
  519.  
  520.